home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / GEDEV100.ZIP;1 / GE_DEV.DOC < prev    next >
Encoding:
Text File  |  1992-10-12  |  5.6 KB  |  164 lines
  1.  
  2.  
  3.  
  4.  
  5.                                    GEDEV 1.00
  6.  
  7.                                  Developers Kit
  8.  
  9.                                  for GEcho 1.00
  10.  
  11.  
  12.                              Last updates: 12-Oct-92
  13.  
  14.  
  15.  
  16.                  Documentation written by Gerard J. van der Land
  17.                     Copyright (C) 1992 Gerard J. van der Land
  18.                                All rights reserved
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.      Gerard J. van der Land
  39.      Cannenburg 23
  40.      3772 BH Barneveld
  41.      The Netherlands
  42.  
  43.      FidoNet 2:283/15
  44.      SIGnet 27:4331/109
  45.  
  46.      Phone: +31-3420-21792
  47.  
  48.      If you should want to call me from the USA, please note that the time
  49.      in Holland is 6 to 8 hours later (GMT+1), so please call between 13:00
  50.      and 18:00 ET.
  51.  
  52.      My system is only online on Monday-Friday from 07:00 - 16:30 CET,
  53.      which is 01:00 - 10:30 US Eastern Time and 06:00 - 15:30 GMT.
  54.      Modem: USRobotics HST 16.8K dual standard with V.32bis
  55.  
  56.      The GE environment variable
  57.  
  58.  
  59.      GEcho and GSETUP will first try to open SETUP.GE in the current
  60.      directory. If that fails, it uses the path name pointed to by the GE
  61.      environment variable. Notice that this variable can also contain a
  62.      text color to be used by the software. I know some people may think
  63.      that's stupid, but that's the way it is and I'm not going to change
  64.      it. :-)
  65.  
  66.      The directory where SETUP.GE was found is considered the "system
  67.      path", where a few other system files are stored too.
  68.  
  69.      The system files
  70.  
  71.  
  72.      SETUP.GE      The system file, contains addresses, pathnames,
  73.                    filenames, etc.
  74.  
  75.                    Your software should check that the system file
  76.                    revision level (sysrev) is the same as GE_THISREV.
  77.  
  78.      AREAFILE.GE   The area database, contains information about the
  79.                    areaname, comment, areanumber, systems to export to,
  80.                    etc. The file consists of a header and area records.
  81.  
  82.                    Your software should check that Area.hdrsize is not
  83.                    smaller than the sizeof(AREAFILE_HDR) expected by your
  84.                    software.
  85.  
  86.                    The area records themselves consist of two parts.
  87.                    The total size (arearecsize) of both parts is:
  88.                    AreaHdr.recsize + AreaHdr.systems * sizeof(EXPORTENTRY)
  89.  
  90.                    To read the first part of an area record, you must
  91.                    first do a file seek to the following position:
  92.                    AreaHdr.hdrsize + counter * arearecsize
  93.                    You can then read up to AreaHdr.recsize bytes.
  94.  
  95.                    To read the second part (the export list), you must add
  96.                    Area.recsize to the previous position and do a file
  97.                    seek to that location. You can then read up to
  98.                    AreaHdr.systems * sizeof(EXPORTENTRY) bytes.
  99.  
  100.                    GEcho itself will get both parts with one read command,
  101.                    and therefore GSETUP must be used to adjust the area
  102.                    database to the area recordsize used by your GEcho
  103.                    version.
  104.  
  105.                    The records are not necessarily sorted in any
  106.                    particular order, but "GSETUP Pack" will sort them
  107.                    alphabetically by areaname.
  108.  
  109.                    Area numbers 1-200 are reserved for areas in Hudson
  110.                    message base boards.
  111.                    Area numbers 201-1024 are reserved for *.MSG and
  112.                    passthru areas.
  113.  
  114.  
  115.      AREAFILE.GEX  The area database index file, contains CRC-32's on the
  116.                    area names, the area number and the file offsets of the
  117.                    area records. The entries are sorted alphabetically by
  118.                    areaname.
  119.  
  120.      NODEFILE.GE   The node database, contains information about the
  121.                    nodes, name of the sysops, which compression programs
  122.                    they prefer, etc. The file consists of a header and
  123.                    area records.
  124.  
  125.                    Your software should you check that Node.hdrsize is not
  126.                    smaller than the sizeof(NODEFILE_HDR) expected by your
  127.                    software.
  128.  
  129.                    To read a node record, you must first do a file seek to
  130.                    the following position:
  131.                    NodeHdr.hdrsize + counter * NodeHdr.recsize
  132.                    You can then read up to NodeHdr.recsize bytes.
  133.  
  134.                    The records are not necessarily sorted in any
  135.                    particular order, but "GSETUP Pack" will sort them by
  136.                    node number.
  137.  
  138.      NODEFILE.GEX  The node database index file. The entries are sorted by
  139.                    node number.
  140.  
  141.  
  142.      PACKFILE.GE   This file contains information about how to route
  143.                    netmail messages, packed with GEcho Pack. The Via
  144.                    entries are sorted by priority and node number.
  145.  
  146.  
  147.      ECHODUPE.GE   This file contains CRC-32's of imported and exported
  148.                    echomail messages, which enables GEcho to detect
  149.                    duplicates. The number of entries in this file can be
  150.                    changed in GSETUP.
  151.  
  152.  
  153.      FTSCPROD.GE   This file contains the names of programs that have a
  154.                    FTSC assigned product code and their capability.
  155.  
  156.      Structures and sample source code
  157.  
  158.  
  159.      This GEDEV archive contains two archives with structures and sample
  160.      source code:
  161.  
  162.      C.ZIP         Contains a .h header file and .c source code.
  163.  
  164.      PASCAL.ZIP    Contains a .inc include file and .pas source code.